Ektron CMS400.Net Reference

>>Managing User Communities > Invite Server Control

Invite Server Control

Warning! The default From email address used to send all invitations is [email protected]. Ektron, Inc. strongly recommends changing this address. See Also: An Invitation’s "From" email Address.

The Invite server control allows site visitor to invite people to join the site or become a colleague. The control displays a dialog box that prompts for several email addresses. The dialog includes an optional message, which appears in the body of the email.

The site visitor can edit or delete the message.

Note: Messages are defined in the Ektron CMS400.NET Workarea. For more information on that, see Email Invitations for Community Management.

An Invitation’s "From" email Address

All invitations have a single "from" email address. Its default value is [email protected]. Your site administrator should change it to one that is appropriate for your organization. To change all invitations' "from"email address, open your site’s web.config file and change the value of following key.

<add key="ek_InvitationFromEmail" value="[email protected]"/>

Invite Server Control Properties

The Invite server control properties are described in this table.

Note: The following table only lists Ektron-specific properties. It does not describe native .NET properties such as font, height, width and border style. For documentation of these properties, see Visual Studio help.

Property

Description

Data Type

Authenticated

Indicates if you are logged in to the CMS Explorer and can use it to browse to Content, Collections, etc.

See Also:

Working with Ektron CMS400.NET Server Controls

String

DisplayXslt

Determines how information is displayed on the page. Enter the path to the XSL file. It can be relative or absolute.

Warning! If you specify an external file, it is strongly recommended that you do not store this file in your site's Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

Warning! If you enter a valid EkML file at the MarkupLanguage property, the DisplayXslt property value is ignored.

String

 

DoInitFill

By default, Fill occurs during the Page_Init event. Set to false if you want to postpone the fill-action until later. In this case, FIll is automatically called during the Page Render event.

You might do this if you need to set or change a property on the control in codebehind and have it render with your changes shown.

Boolean

FriendMessageId

The ID of the message to send in the link section of a FriendInvitation type email.

This message is defined in the Workarea > Settings > Community Management > Messages. See Also: Email Invitations for Community Management

If set to 0 (zero), the server control uses the default message.

Long

Hide

Used to hide output of the control in design time and run time.

True = Hide control

False = Display control

Boolean

InviteMessageId

The ID of the message to send in the link section of a GroupInvitation or FriendInvitation email.

This message is defined in the Workarea > Settings > Community Management > Messages. See Also: Email Invitations for Community Management

If set to 0 (zero), the server control uses the default message.

String

Language

Set a language for viewing the Invite server control. This property shows results in design-time (in Visual Studio) and at run-time (in a browser).

Integer

OptionalMessageText

The body text of the email message. The text appears in the Invite server control’s dialog box and can be edited by site visitors when they use the Invite control.

String

Stylesheet

Specify the path to a style sheet for use with the server control. The location can be relative or absolute. Leave blank to use the default style sheet.

Warning! If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

String

SuppressWrapperTags

Suppresses the output of the span/div tags around the control. The default is False.

True - Suppress wrap tags.

False - Allow wrap tags.

Boolean

WrapTag

Allows a developer to specify a server control’s tag.

The default is Span.

Span - The <span> tag is used to designate an inline portion of an HTML document as a span element.

Div - The <div> tag is used when you want to apply attributes to a block of code.

Custom - Allows you to use a custom tag.

String


Visit the Ektron Dev Center at http://dev.ektron.com 1-866 - 4 - EKTRON

Ektron CMS400.NET Reference Version 8.02 SP1 Rev 1

Ektron Documentation,© 2011 Ektron, Inc.